Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add print-block cmd to scripts README #1096

Merged
merged 2 commits into from
Feb 26, 2024
Merged

Add print-block cmd to scripts README #1096

merged 2 commits into from
Feb 26, 2024

Conversation

dydxwill
Copy link
Contributor

Changelist

Add print-block cmd to scripts README

Test Plan

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Copy link
Contributor

coderabbitai bot commented Feb 26, 2024

Walkthrough

The update enhances the script execution command by incorporating environment variable settings for KAFKA_BROKER_URLS and SERVICE_NAME. This improvement facilitates better interaction with Kafka brokers and enhances service identification during execution.

Changes

File Path Change Summary
indexer/services/scripts/README.md Added environment variable settings for KAFKA_BROKER_URLS and SERVICE_NAME in the script execution command.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between dcd2d9c and 50f2cb6.
Files selected for processing (1)
  • indexer/services/scripts/README.md (1 hunks)

Comment on lines 20 to 21
KAFKA_BROKER_URLS=b-1.devindexerapne1ms.e0k85v.c3.kafka.ap-northeast-1.amazonaws.com:9092 \
SERVICE_NAME=scripts pnpm run print-block -- --h 9265388
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The addition of KAFKA_BROKER_URLS and SERVICE_NAME environment variables in the script execution command enhances the documentation by providing clear instructions on how to configure the script for different environments. This is a positive change that improves the usability and configurability of the scripts. However, it would be beneficial to include a brief explanation or description of these environment variables directly in the README for users unfamiliar with their purpose or how to obtain their values. Adding such descriptions can further improve the documentation's clarity and usefulness to new users or contributors.

@@ -15,6 +15,10 @@ Example:
pnpm run validate-pnl -- \
--s 964e4f37-1314-5181-bcf9-d3b0a30d86ed \
--p d6f67aac-749d-5f62-8a55-ef825915b575 d6f67aac-749d-5f62-8a55-ef825915b575


KAFKA_BROKER_URLS=b-1.devindexerapne1ms.e0k85v.c3.kafka.ap-northeast-1.amazonaws.com:9092 \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I don't think we want to expose our dev kafka url in README

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 50f2cb6 and 352833d.
Files selected for processing (1)
  • indexer/services/scripts/README.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • indexer/services/scripts/README.md

@dydxwill dydxwill merged commit 0de0096 into main Feb 26, 2024
11 checks passed
@dydxwill dydxwill deleted the wl/addrm branch February 26, 2024 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants